/*
 *
 * Copyright (c) 2006-2020, Speedment, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); You may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.speedment.runtime.core.component;

import com.speedment.runtime.config.identifier.TableIdentifier;
import com.speedment.runtime.field.Field;

import java.util.stream.Stream;

public interface PersistenceTableInfo<ENTITY> {
    /**
     * Returns an identifier for the table.
     *
     * @return the table identifier
     */
    TableIdentifier<ENTITY> getTableIdentifier();

    /**
     * Returns the entity class for this Manager.
     *
     * @return the entity class
     */
    Class<ENTITY> getEntityClass();

    /**
     * Returns a stream of the fields of the table.
     *
     * @return a stream of all fields
     */
    Stream<Field<ENTITY>> fields();

    /**
     * Returns a stream of the fields that are included in the primary key of
     * the table.
     *
     * @return the primary key fields
     */
    Stream<Field<ENTITY>> primaryKeyFields();

}
